/*
 * Copyright © 2018 www.noark.xyz All Rights Reserved.
 *
 * 感谢您选择Noark框架，希望我们的努力能为您提供一个简单、易用、稳定的服务器端框架 ！
 * 除非符合Noark许可协议，否则不得使用该文件，您可以下载许可协议文件：
 *
 *        http://www.noark.xyz/LICENSE
 *
 * 1.未经许可，任何公司及个人不得以任何方式或理由对本框架进行修改、使用和传播;
 * 2.禁止在本项目或任何子项目的基础上发展任何派生版本、修改版本或第三方版本;
 * 3.无论你对源代码做出任何修改和改进，版权都归Noark研发团队所有，我们保留所有权利;
 * 4.凡侵犯Noark版权等知识产权的，必依法追究其法律责任，特此郑重法律声明！
 */
package xyz.noark.core.lang;

/**
 * 字节数组的接口.
 * <p>
 * 只是一个申明此实现是一个字节数组用于传递.
 *
 * @author 小流氓[176543888@qq.com]
 * @since 3.1
 */
public interface ByteArray extends AutoCloseable {
    /**
     * 返回字节数组内容.
     *
     * @return 字节数组
     */
    byte[] array();

    /**
     * 用于Try方式的关闭资源或回收功能.
     */
    @Override
    void close();

    /**
     * 返回字节数组长度.
     *
     * @return 数组长度
     */
    int length();

    /**
     * 获取指定位置的字节.
     *
     * @param index 指定位置
     * @return 指定位置的字节
     */
    byte getByte(int index);

    /**
     * 设置指定位置的字节内容
     *
     * @param index 指定位置
     * @param value 字节内容
     */
    void setByte(int index, byte value);
}